gridpack::optimization::BoundedVariableT< T > Class Template Reference

Represents a variable that may or may not have bounds. More...

#include <variable.hpp>

Inheritance diagram for gridpack::optimization::BoundedVariableT< T >:

[legend]

Collaboration diagram for gridpack::optimization::BoundedVariableT< T >:

[legend]

List of all members.

Public Member Functions
	BoundedVariableT (const T &value)
	Construct with an initial value.
	BoundedVariableT (const T &value, const T &lo, const T &hi)
	Construct with an initial value and bounds.
	~BoundedVariableT (void)
	Destructor.
T	initial (void) const
	Get the initial value.
void	initial (const T &value)
	Set the initial value.
bool	bounded (void) const
	Is this variable bounded.
T	lowerBound (void) const
T	upperBound (void) const
Static Public Attributes
static const T	veryLowValue
	lower bound for unbounded variables
static const T	veryHighValue
	upper bound for unbounded variables

---

Detailed Description

template<typename T>
class gridpack::optimization::BoundedVariableT< T >

Represents a variable that may or may not have bounds.

---

Constructor & Destructor Documentation

template<typename T>

gridpack::optimization::BoundedVariableT< T >::BoundedVariableT

(

const T &

value

)

Construct with an initial value.

template<typename T>

gridpack::optimization::BoundedVariableT< T >::BoundedVariableT	(	const T &	value,
		const T &	lo,
		const T &	hi
	)

Construct with an initial value and bounds.

template<typename T>

gridpack::optimization::BoundedVariableT< T >::~BoundedVariableT

(

void

)

Destructor.

---

Member Function Documentation

template<typename T>

bool gridpack::optimization::BoundedVariableT< T >::bounded

(

void

)

const

Is this variable bounded.

template<typename T>

void gridpack::optimization::BoundedVariableT< T >::initial

(

const T &

value

)

Set the initial value.

template<typename T>

T gridpack::optimization::BoundedVariableT< T >::initial

(

void

)

const

Get the initial value.

template<typename T>

T gridpack::optimization::BoundedVariableT< T >::lowerBound

(

void

)

const

template<typename T>

T gridpack::optimization::BoundedVariableT< T >::upperBound

(

void

)

const

---

Member Data Documentation

template<typename T>

const T gridpack::optimization::BoundedVariableT< T >::veryHighValue [static]

upper bound for unbounded variables

template<typename T>

const T gridpack::optimization::BoundedVariableT< T >::veryLowValue [static]

lower bound for unbounded variables

---

The documentation for this class was generated from the following file:

• variable.hpp